-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(cloudwatch): render region and accountId when directly set on metrics #29935
fix(cloudwatch): render region and accountId when directly set on metrics #29935
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
The PR linter says "Fixes must contain a change to an integration test file and the resulting snapshot." Is there an existing integration test that's relevant to this functionality? I'm happy to add one, but I could use some direction. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
Clarification Request: How can I address the linter failure? |
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing |
Issue
Closes #28731
Reason for this change
Currently, if a user creates a metric that includes
region
andaccountId
, those fields are omitted when the metric renders in a stack with those same values. The intended behavior is to omit those fields when they're implicitly set viametric.attachTo(stack)
, not to omit them when set directly by the user.This change differentiates those behaviors and adds a test case.
Description of changes
The key changes here are on the
Metric
class. Previously,region
andaccount
were public properties that were set bymetric.attachTo(stack)
, making it impossible to differentiate whether they were set directly or viaattachTo
. To differentiate them while maintaining backward compatibility, I took this approach:attachTo
sets internal properties calledstackRegion
andstackAccount
. Settingregion
andaccount
directly sets internal properties calledregionOverride
andaccountOverride
.region
andaccount
properties are now getters that return the override (if set) and fall back on the stack properties.toMetricConfig()
method returns theregion
andaccount
from the getters, but also includes theregionOverride
andaccountOverride
.That way, everything that looks at
region
andaccount
works the same way it did before, except inmetricGraphJson
, which skips the "if different from stack" tokenization if the overrides are set.Description of how you validated changes
All existing unit tests are satisfied by these changes.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license